Freelance Dashboard

The Complete Client & Project Management Application

Please note that Support and Updates are only available to customers who have genuine copies of this software.

INSTALLATION GUIDE

SYSTEM REQUIREMENTS

UNZIP AND UPLOAD FILES VIA FTP

Once you have downloaded your copy of the software, place it on your desktop and unzip the folder. You will now have a directory with a structure shown below

DIRECTORY STRUCTURE
FIG.1

Upload all the files into your website's FTP folder. You can use an FTP client like WS_FTP.

CHMOD FOLDERS & FILES

The following folders must have their permissions changed via FTP (CHMOD).

This will make them writeable. Normally you simply right click the specified file/folder on the server side of you FTP Client and you select ‘properties’ you will then have an option to set the permission levels that you want.

Typically for Folder you set the permission level to 777 or 755 (depending on your web host’s settings).
If you have set to 777 and you find you are getting 500 SERVER ERROR then you must CHMOD back to 755.
For file, the permission level needed is normally 666


  • /updates
  • /files
  • /files/avatars
  • /files/backups
  • /files/captcha
  • /files/projects
  • /files/temp
  • /files/tickets
  • /files/tasks
  • /application/logs
  • /application/cache
  • /application/config/database.php

MySQL DATABASE

You will need a MySQL database in order to install the application. You can easily create one via your web hosting providers Control Panel (e.g. Cpanel).
When you have finished created your database via your control pane, you should now have the following information:

  • DATABASE NAME
  • DATABASE USERNAME
  • DATABASE PASSWORD

START THE INSTALLATION WIZARD

Open your website to a url similar to the one below. You must replace the words yourdomain.com with your real domain name. Follow all the steps to complete your installation

http://www.yourdomain.com/install


wizard
FIG.2

INSTALLING INTO A SUB-FOLDER

To avoid problems, please read these instructions carefully and completely

IMPORTANT (1): Use these instructions only IF you have installed to a SUBFOLDER. These instructions not NOT be used when installing to a SUBDOMAIN

SUBFOLDER : http://www.yourdomain.com/myclients

SUBDOMAIN: http://myclients.yourdomain.com

If you are installing into a sub-folder e.g. http://www.yourdomain.com/sub folder you must follow all the instructions as above and then edit the .htaccess file that is the main folder of this application.

IMPORTANT (2): If you are installing in a subfolder, DO NOT name the sub-folder 'clients' or 'admin' this will create a conflict with folders of the same name in the application.

OK : http://www.yourdomain.com/account

NOT OK: http://www.yourdomain.com/clients

NOT OK: http://www.yourdomain.com/admin


You will see a section in the .htaccess file, for you to type in your sub folder name.

You then upload this file into your FTP

Your directory structure will look like the image below

sub-folder
FIG.2.1

LOGIN INTO YOUR DASHBOARD

Once you have completed your installation, you will be able to access the application as follows:
  • ADMIN PANEL - http://www.yourdomain.com/admin
  • CLIENT PANEL - http://www.yourdomain.com/client
login
FIG.3


CLIENTS

Clients are normally companies that you do projects for. Even if you client is an individual person, you need to first add them to the dashboard as a 'client/company) Once you have created your client, you will be able to add various users for this client (i.e. people who will have rights to login to the dashboard for this client)

CLIENTS MAIN MENU SECTION

To access this section. click on CLIENTS on the main menu. From the client main menu section you can do the following:

HOW TO ADD A CLIENT

To add a client, click on CLIENTS on the MAIN MENU and then click on the ADD NEW CLIENTS button (as shown below). You will get a new popup window for you to fill in your clients details.

clients
FIG.4

You will be presented with to fill in the clients company details and also the details of the main contact person at the company. The person you specify here will receive an email automatically with their login details. The main contact (primary contact) is also the one who will receive all system generated emails such as invoices, notifications etc.

add client
FIG.5

HOW TO DELETE A CLIENT

Do delete a client, you simply click the delete icon (delete) as shown in FIG.4. When you delete a client, all of that clients related data is also deleted. This included Projects, Invoices, Payments, Messages Files etc.

IMPORTANT: This process cannot be reversed

CLIENT DASHBOARD

The client dashboard is place where all the details of one client can be viewed (all in one place). You can access this dashboard by clicking on the clients name as show in FIG.4 above.
From the client dash board you can do/access all the items listed below:

client-profile
FIG.6

 

Projects

Projects are the at the heart of this application. Most things revolve around projects.
This means that most items will belong to a particular project. Files, invoices, bugs, tasks, comments etc, all belong to a project.

Before you can do any of these things, you will need to create a project. The system admin has the right to create new projects on behalf of the client.

PROJECTS MENU SECTION

To access this section. click on ALL PROJECTS on the main menu. From the Projects Main Menu section you can do the following:

To create a new project, simply click on the ADD NEW PROJECT button as shown below. A form will appear for you to fill in all the project details.

projects
FIG.7

Once you have created/added a new project, your client will automatically receive an instant notification, with details of the new project.

PROJECT DASHBOARD

The project dashboard is place where all the details of one project can be viewed (all in one place). You can access this dashboard by clicking on the project from the list, as show in FIG.7
From the project dash board you can do/access all the items listed below:

NOTE: The items with an asterisk* are only available to the ADMIN or a PROJECT LEADER. Other team members who do not have rights will not see these menu options
project panel
FIG.8

 

TEAM MEMBERS & GROUPS

If you work in a team, this application allows you to add as many TEAM MEMBERS as you like. Each team member must belong to a particular GROUP. The starting point is to make sure that you have some groups. The system comes with some some default groups (which you can delete and create you own if you want).

Groups are like departments in a company. For software company, the departments could be as an example

If you work alone you do not really need to have any additional groups, apart from the default group ADMINSTRATORS, which is automatically created when you install the application.

To create a group, simply click on the GROUPS ICON on the TOP ADMIN MENU as shown below

groups
FIG.9

GROUP PERMISSIONS

This application comes advanced permission controls, which allow the ADMINISTRATOR to specify the permissions that GROUPS have across the application's various resources. TEAM MEMBERS get their permission and level of access based on the GROUP that they belong to.

NOTE: PROJECT LEADERS will have great access/permission for the particular project than what their group permissions normally allow.

GROUP PERMISSIONS

To change permission levels for a particular group, click on the groups name from the list of groups(see FIG.9) .
you will the be presented with a popup that will allow you to specify the groups permission levels. Permission levels are set on a scale called PERMISSION LEVELS. This scale ranges from 0-4.

The table below show what rights each level grants for each category/section or item in the dashboard.

permissions matrix
FIG.10

NOTE: The ADMINISTRATOR group has FULL permissions as default. These cannot be changed.


permissions
FIG.11
IMPORTANT: In the interest of security and effective operation of the application, some categories will not allow you to change their permissions level ABOVE or BELOW a certain level.

 

MILESTONES & TASKS

To make managing a project easy, it must be split into smaller segments. A project is first broken its broad segments called MILESTONES. You can think of milestones as goals that you want to reach in a given period of time. Example of these broad goals can be:

  • DESIGN CONCEPTS
  • FRONTEND DEVELOPMENT
  • BACKEND DEVELOPMENT
  • TESTING & HANDOVER

Inside these broad segments, you can now create DAY TO DAY - TASKS. This is the actual work items that are needed to complete the MILESTONES.

To create MILESTONES and TASKS, you need to enter the particular PROJECTS

milestones
FIG.12

To add TASKS see the image below

tasks
FIG.13

FILES

You can your client can both upload and share files to a particular project. To upload files, please see the image below. Once you have uploaded your files, you can click them view more details.

files
FIG.14

Once you have created a file, you and your client can download it and also post COMMENTS


file comments
FIG.15

MESSAGING

The application allow you to communicate effectively with your CLIENTS and also you TEAM MEMBERS. You will see the POST A COMMENT button in various areas of the application.

messages
FIG.16

NOTE: Team Messages are private and cannot be viewed by the client. You can use them to discuss the project within your team.

SUPPORT TICKETS

The application comes with a full featured SUPPORT TICKETS section. You and your clients can create and reply to tickets via this section. Tickets can also have file attachments. Please see image below to see how to access the SUPPORT TICKETS feature.

tickets
FIG.17

BUGS

The application comes with a BUG TRACKING feature, which allows your clients to report any bugs that they find in your products. To access the BUG TRACKER, click on the BUGS link on the MAIN MENU

bugs
FIG.18

QUOTATIONS

The applications allows you to create forms that your existing clients or potential clients can fill in to request a quotation from you.

Once you clients have filled in the quotation forms, you will be able to price them and let them know how much the work will cost.

We have included a default QUOTATION FORM, but you can create your own forms using the easy to use QUOTATION FORM BUILDER

QUOTATION FORM BUILDER & QUOTATIONS

The system is made of 2 parts, as follows

QUOTATION FORM BUILDER - MAKING YOUR OWN FORM

To create your own quotation form, you click on the QUOTATION FORMS menu and then the CREATE NEW FORM BUTTON (as shown below)


forms
FIG.18.1

You will be presented with the form builder. This is a simple to use tool for dynamically created web forms (Quotation Forms) that you clients can fill in.

Please see the images below for the steps to take to create your form

step-1
FIG.18.2

NEXT

step-2
FIG.18.3

When you have added all your form fields, you save the form. This new Quotation Form will now be added to your list of forms.


HOW DO CLIENTS FILL IN THESE FORMS?

Once you have created your Quotation Forms, then next important thing is to give you clients access to these forms.



SYSTEM SETTINGS

At the heart of this application is the very advanced SETTINGS management section. We have made sure that you will rarely need to manually edit any settings files or config files in order to make system wide changes.

The SETTINGS section has various tabs, which will allow you to configure those aspects of the PRODUCT. We have included some instructions for the various settings sections (within the application)

settings
FIG.19

GENERAL SETTINGS

General settings allow you to set the system wide config values. These include
NOTE: You will not be able to download updates if you do not have a valid product purchase code

COMPANY SETTINGS

This is where you set all your company information (name, telephone, etc)

INVOICE SETTINGS

These settings affect how invoices are paid by your clients

PAYPAL SETTINGS

These settings are for your paypal payment gateway.

EMAIL TEMPLATES SETTINGS

The system has an easy to use editor for editing all the emails that are sent out by the application. Simply select the template you want to edit and save your changes.

email templates
FIG.20

SUPPORT TICKETS SETTINGS

The Support Tickets settings page allows you to do all the following:
tickets
FIG.21

OPTIONAL FORM FIELDS SETTINGS

The application allows you to add additional form fields to the following forms:

This allows you to collect additional information which is not a part of the default forms. Below are just some example of what you could add using this option

To enable these optional fields, simply fill out the form.

optional fields
FIG.22
IMPORTANT NOTICE: In order to keep your data consistent, do not keep changing the forms. Remember that the information already stored will not be changed when you rename a form. Meaning that if your form was asking for FTP login details and you have now changed it to as for TAX details, some of your old clients data will not jake sense unless you also update it.

CRON JOBS SETTINGS

Cron Jobs are tasks that are run in the background at set intervals. Cron Jobs are used for example to automatically send invoice reminder messages. In order for the application do this, your web hosting account will need to allow Cron Jobs. You will typically have to copy and paste the link that is provided into your web hosting control panels cron form. Web hosting control panels such as CPANEL / PLESK etc will easily allow you to do this.

The URL that you will need is provided in this section of the settings page.

DATABASE BACKUP SETTINGS

Its vitally important that you always maintain a backup copy of your database. The application provides you with an easy way to download a backup copy of your database.

database backup
FIG.23
IMPORTANT: This backup is only for your MySQL Database File ONLY file. It will NOT include all your application files and any uploaded files. To have a complete backup of your system, you must also regularly make a full FTP download of your entire installation. Other web hosting control panels such as CPANEL will allow you do your backup via their control panel


APPLICATION STRUCTURE

This application is built on the CODEIGNITER framework. You can learn more about this FRAMEWORK by visiting http://www.codeigniter.com

file-structure

UPDATES

Every now and then we will release updates that either fix bugs or add new functionality.

You can view all available updates via the SETTINGS section of the application.

Please note that you can only download updates if you have a valid PRODUCT PURCHASE CODE. This is the code that you received when you made your purchase.

IMPORTANT: You must download your updates only via your dashboard.
  • - To updates, you simply download the updates zip file, and upload the files into your FTP.
  • - Updates will NEVER require you to follow the installation wizard.
  • - If you find yourself following the installation wizard as part of an update, you have done something wrong and you risk overwriting your database

    • HOW To's

    Frequently Asked Questions

    How to change the favicon

    To change the favicon, simply upload your own favicon.png file to replace the default one.

    The default favicon is found in your FTP folder /application/themes/default/common/img/favicon/favicon.png
    Back to - How To's & FAQ

    How to setup your CronJob

    Cronjobs are used to automate certain process inside your Freelance Dashboard application.

    If you have not completed the Cronjobs setting up process, you will notice some errors on your system, such as emails/notifications not being sent out to clients etc.
    To setup your Cronjobs, follow the steps below

    [STEP 1] - Get cronjob url from inside your dashboard

    First, you must login into your Dashboard and copy the Cronjob URL.
    The cronjob url is found user SETTINGS inside your dashboard. The image below shows you how to do this.
    1. Click on Settings on the to menu
    2. Click on Cronjob on the sub menu
    3. Copy the url as shown below. Example Cronjon URL: wget http://your-domain.com/admin/cronjobs/general/AHusEwFd8HDg630sk >/dev/null
    Please notice the word wget in the url. This is important and must be included in your url


    cronjobs

    [STEP 2] - Add the Cronjob in your web hosting dashboard (e.g. Cpanel)

    The next thing you will need to do is to add the cronjob url inside your web hosting control pane. In this example below, we are using a CPANEL based web hosting.

    Your own web hosting control panel may be different, however the concept is the same

    cronjobs

    cronjobs
    Back to - How To's & FAQ

    How to increase upload file size limit

    You will need to edit the following file(s)
    $config['files_max_size']	= 20000; //in kilobytes
    Back to - How To's & FAQ

    FAQ - Why is my logo not showing on my PDF invoice

    If your logo is not showing on your PDF invoices and you are getting instead the text "File not found", you need to contact your web hosing provider and ask them to enable allow_url_fopen on your website.
    Back to - How To's & FAQ

    HOW TO: Create A New Invoice

    To create a new invoice, please see the NUMBERED STEPS shown in the images below
    1. Select the project you want to issue an invoice for (click on All Projects or My Projects) on the main menu and on the next screen, select your project
    2. Click on Invoices on the Project Menu
    3. Click on the Add Invoice button - A popup will appear, fill in the form


    Once you have created the invoice, you will now need to add items to the invoice. Please see the image below
    Back to - How To's & FAQ

    HOW TO: Add Tax/VAT to an invoice

    To add TAX or VAT to an invoice, start be selecting the invoice from your list of invoices.

    You then click on the Edit Invoice button. A popup will appear for you to edit the invoice, which includes being able to add TAX/VAT.

    See image below:

    Back to - How To's & FAQ

    FAQ: I cannot find the .htaccess file

    You need to edit the .htaccess when you have done an installation in a subfolder.

    However for some users (particularly on Mac's) they are unable to "view/find" the .htaccess file inside the download file.


    To solve this, you can download the file HERE

    This is the zipped copy of the file. You will need to unzip it.
    Back to - How To's & FAQ

    HOW TO CHANGE NUMBER DECIMAL FORMAT

    You can change how amounts are displayed in your dashboard. The default is 1,000.00 , but you can also change to anything you like. e.g. 1.000,00

    To do this you will need to edit the file /application/views/common/runtime.functions.php.

    You must use a plain text editor like notepad

    STEP 1 - Look for the function named runtime_number to find this you can do a search in the file above

    STEP 2 - Edit the line shown below
    $CurrVal = number_format($CurrVal);
    #EXAMPLE OUTPUT: 1.000,00
    Change the line and add what is shown below
    $CurrVal = number_format($CurrVal, 2, '.', ',');
    For more information of number formatting, please see
    http://php.net/number_format
    Back to - How To's & FAQ

    How to enable SSL redirect

    You will need to edit the following file(s)
    This file may be hidde by your computer's settings. You may need to enable viewing of hidden files(as is applicable for your computer's operating system)
    Add the following code at the top of this file. Save upload it via FTP to your website 
    
#-------------------SSL REDIRECT START---------------------------------
RewriteEngine on
RewriteCond %{HTTPS} off
RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
#-------------------SSL REDIRECT END-----------------------------------
    Back to - How To's & FAQ

    some title here

    Foo bar
    Back to - How To's & FAQ